Skip to content

Fix @return annotation for CompositeUrlRule::createRules() #20585

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Oct 13, 2025
Merged

Fix @return annotation for CompositeUrlRule::createRules() #20585

merged 3 commits into from
Oct 13, 2025
+2 −1

Conversation

mspirkov
Copy link
Contributor

@mspirkov mspirkov commented Oct 8, 2025

Q A
Is bugfix? ✔️
New feature? ❌
Breaks BC? ❌
Fixed issues

mspirkov
mspirkov commented Oct 8, 2025
View reviewed changes
framework/web/CompositeUrlRule.php
/**
* Creates the URL rules that should be contained within this composite rule.
* @return UrlRuleInterface[] the URL rules
* @return UrlRuleInterface[]|UrlRuleInterface[][] the URL rules
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

@mspirkov mspirkov marked this pull request as ready for review October 8, 2025 13:05
Arhell
Arhell reviewed Oct 10, 2025
View reviewed changes
Copy link
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

samdark
samdark reviewed Oct 10, 2025
View reviewed changes
framework/web/CompositeUrlRule.php
/**
* Creates the URL rules that should be contained within this composite rule.
* @return UrlRuleInterface[] the URL rules
* @return UrlRuleInterface[]|UrlRuleInterface[][] the URL rules
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is in the structure with additional array?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an array of the form array<string, UrlRuleInterface[]>. It contains several sets of rules grouped by URL name.

yii2/framework/rest/UrlRule.php

Line 179 in 9093960

$rules[$urlName][] = $this->createRule($pattern, $prefix, $controller . '/' . $action);

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is always like that or UrlRuleInterface[] is valid as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

UrlRuleInterface[] is valid as well

yii2/framework/web/GroupUrlRule.php

Lines 109 to 116 in 9093960

$rule = Yii::createObject(array_merge($this->ruleConfig, $rule));
if (!$rule instanceof UrlRuleInterface) {
throw new InvalidConfigException('URL rule class must implement UrlRuleInterface.');
}
$rules[] = $rule;
}
return $rules;

@mspirkov mspirkov requested a review from samdark October 13, 2025 07:03
@samdark samdark merged commit dcb88b8 into yiisoft:master Oct 13, 2025
94 checks passed
@samdark
Copy link
Member

samdark commented Oct 13, 2025

Thank you!

1 similar comment
@samdark
Copy link
Member

samdark commented Oct 13, 2025

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@terabytesoftw terabytesoftw terabytesoftw approved these changes

@samdark samdark Awaiting requested review from samdark

+1 more reviewer

@Arhell Arhell Arhell left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@mspirkov @samdark @Arhell @terabytesoftw